Interface MgntAccessSetting

All Superinterfaces:
IPCObject
All Known Implementing Classes:
MgntAccessSettingImpl

public interface MgntAccessSetting extends IPCObject
Information provided by the PKI file:

    \class CMgntAccessSetting
    
    \brief CMgntAccessSetting is used to control telnet and ssh access into the asa
    
    \example network().getDevice("Router0").getAsaMgntAccessManager()
    
Author:
Auto-generated
  • Method Details

    • getAccessProtocol

      AccessProtocol getAccessProtocol()
      Information provided by the PKI file:
      
          \brief Return the access protocol
          eTelnet =0,
          eSsh,
          eHttp
          
              
      Returns:
      AccessProtocol Returns a AccessProtocol
    • getAllowedIp

      IPAddress getAllowedIp()
      Information provided by the PKI file:
      
          \brief Return the ip address that is allowed to access the asa
          
          \return ip, value is the ip address that is allowed to access the asa.
          
              
      Returns:
      IPAddress Returns a IPAddress
    • getAllowedMask

      IPAddress getAllowedMask()
      Information provided by the PKI file:
      
          \brief Return the mask address of the host that is allowed to access the asa
          
          \return ip, value is the mask address of the host that is allowed to access the asa.
          
              
      Returns:
      IPAddress Returns a IPAddress
    • getAllowedPrefix

      int getAllowedPrefix()
      Information provided by the PKI file:
      
          \brief Return the prefix of the host that is allowed to access the asa
          
          \return int, value is the the prefix of the host that is allowed to access the asa.
          
              
      Returns:
      int Returns a int
    • getSrcNameIf

      String getSrcNameIf()
      Information provided by the PKI file:
      
          \brief Return the nameif at which the host can access into
          
          \return string, value is the nameif at which the host can access into.
          
              
      Returns:
      String Returns a String
    • getTimeout

      int getTimeout()
      Information provided by the PKI file:
      
          \brief Return the timeout of the connection
          
          \return int, value is the timeout of the connection.
          
              
      Returns:
      int Returns a int
    • setTimeout

      void setTimeout(int timeout)
      Information provided by the PKI file:
      
          \brief Set the timeout for the connection
          \param timeout - time in minutes
          
              
      Parameters:
      timeout - Takes in a parameter of timeout
    • toString

      String toString()
      Information provided by the PKI file:
      
          \brief Return the configuration in string
          
          \return string, value is the configuration string.
          
              
      Overrides:
      toString in class Object
      Returns:
      String Returns a String
    • setIpv4

      void setIpv4(boolean isIpv4)
      Information provided by the PKI file:
      
          \brief set the access setting to ipv4 when it permits an ipv4 address
          \param isIpv4 - true if ipv4; false if ipv6
          
              
      Parameters:
      isIpv4 - Takes in a parameter of isIpv4
    • isIpv4

      boolean isIpv4()
      Information provided by the PKI file:
      
          \brief Return true if the setting allows ipv4 address and false if the setting allows ipv6 address
          
          \return bool, value is true if the setting allows ipv4 address and false if the setting allows ipv6 address.
          
              
      Returns:
      boolean Returns a boolean
    • isActive

      boolean isActive()
      Information provided by the PKI file:
      
          \brief Return true if the setting has all of the required configuration
          for example (ip address is set on the nameif interface)
          
          \return bool, value is true if the setting has all of the required configuration.
          
              
      Returns:
      boolean Returns a boolean
    • setActive

      void setActive(boolean isActive)
      Information provided by the PKI file:
      
          \brief Set the setting to be active or inactive
          
          \param isActive, true to set to active, false to inactive.
          
              
      Parameters:
      isActive - Takes in a parameter of isActive